home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / commodities / docs / noisome.doc < prev    next >
Text File  |  1996-09-07  |  11KB  |  284 lines
  1.  
  2. **************************************************************************
  3. *                                     *
  4. *                Noisome v1.0                 *
  5. *                                         *
  6. *                   User Documentation                     *
  7. *                                     *
  8. *                © 1993 David Larsson             *
  9. *                                     *
  10. **************************************************************************
  11.  
  12. Preface
  13. =======
  14. The program and files in this distribution are freely distributable,
  15. but are also copyright (c) David Larsson. They may be freely
  16. distributed as long as no more than a nominal fee is charged to cover
  17. time and copying costs.
  18.   No commercial usage is permitted without written permission from the
  19. author.  Everything in this distribution must be kept together, in original
  20. unmodified form.
  21.   The above is generally known as freeware.
  22.  
  23.   Please contact me if you have any comments or suggestions:
  24.  
  25.   E-Mail:  f92dala@fy.chalmers.se
  26.  
  27.   Mail:    David Larsson
  28.             Gibraltarg. 82:150
  29.             S-412 79 Göteborg
  30.             Sweden
  31.  
  32. Contents
  33. ========
  34.   1. Introduction
  35.   2. Features
  36.   3. Installation
  37.   4. Usage
  38.   5. ToolTypes
  39.   6. Known problems
  40.   7. Problems never heard of
  41.  
  42. 1. Introduction
  43. ===============
  44. There was a time when every decent computer made beeps when you pressed
  45. a key. That was very cute, but today's computers seem to miss this
  46. feature for some strange reason.
  47.   I don't want it to stay that way, so I've made this program that takes
  48. you back in time and plays any sample you wish when a key is pressed.
  49.   But that's not all, folks! You can have different samples for different
  50. keys, special samples for the mousekeys, a sample to be played instead
  51. of the visual display-"beep", and more...
  52.   To sum up, this is an invaluable tool that adds one or two extra
  53. dimensions to your Amiga-experience. Keep it. Use it.:-)
  54.  
  55. 2. Features
  56. ===========
  57. * Noisome is a standard Commodity and will only work on Workbench 2.04 or
  58.   higher. It works together with the new Sound-prefs in 2.1 and 3.0.
  59. * The program lets you select soundsamples (8SVX, raw data, mono and stereo)
  60.   to be played when any of the following events occur:
  61.  
  62.     Event        Comment
  63.     -----------------------------------------------------------------------
  64.     Visible bell      One of the major improvements in Workbench 2.1 was
  65.                  the ability to play a sample or beep instead of the
  66.                  "flashing screen"-warning. But everybody hasn't
  67.                  upgraded yet, why I have it here.
  68.     Key            Any key that produces a visible output.
  69.     Return        A special sample for this key is required for a
  70.             realistic simulation of a typewriter!
  71.     Space        The same goes for this one.
  72.     Left mousebutton    Only add a sample to this if you really think that
  73.                 you won't go insane and kill your pet or something.
  74.     Right mousebutton    This option only exists for the symmetry, but I'm
  75.                 sure that someone will find a situation where it
  76.                 will come in handy.
  77.     Disk inserted    This can really surprise someone who doesn't know
  78.                 that Noisome is running. A crunching or
  79.                 "swallowing" sound is strongly recommended.
  80.     Disk removed    If you have loads of chipmem, you could always put
  81.                 some interesting sample here.
  82.  
  83. * The overhead is very small, and typing speed doesn't suffer at all. The
  84.   task priority can be set freely. In this way, you can choose whether
  85.   Noisome should give you an accurate response on EVERY click or no
  86.   system performance loss.
  87. * The samples are played in mono or stereo, and two can be played
  88.   simultaneously. (See "Usage" for details). The audio allocation
  89.   priority can also be set. These two settings enable you to decide
  90.   how Noisome will work together with other programs that produce
  91.   beeps, like Sound-preferences, comm-programs etc.
  92. * If several identical samples are chosen for different events, only
  93.   one copy of the sample will be held in memory.
  94. * Of course, the audio filter can be turned off, so you really can enjoy
  95.   those high-pitched, sweet sampled typewritersounds!
  96.  
  97. 3. Installation
  98. ===============
  99. You can try the program out immediately by simply doubleclicking on the
  100. Noisome-icon. For a permanent installation, drag Noisome and Noisome.prefs
  101. to any drawer, preferably WbStartup.
  102.   The supplied preferences are set to look for the samples in a drawer
  103. called 'Samples', which sould be copied to the same directory as Noisome.
  104. Of course, this isn't necessary if you have your own samples.
  105.   The complete path of the prefs-file can be changed with a ToolTypes-
  106. option. This is described in the "ToolTypes"-section of this manual.
  107.  
  108.   The following files should be in the archive:
  109.  
  110.   Name            Description
  111.   -----------------------------------------------------------------------
  112.   Noisome        The program
  113.   Noisome.prefs     Preference file (Old Remington samples)
  114.   Modern.prefs             - " -    (Modern Brother samples)
  115.   Noisome.doc        This file
  116.   Samples/
  117.     Bro_key        Key pressed on an electronic Brother typewriter.
  118.     Bro_return        Carriage return           - " -
  119.     Bro_space        Space key                 - " -
  120.     Rem_key        Key pressed on a Remington, early 30'ies model.
  121.     Rem_return        Carriage return           - " -
  122.     Rem_space        Space key                 - " -
  123.     Oh_uh        Donald Duck has made a mistake...
  124.  
  125. 4. Usage
  126. ========
  127. You can start Noisome either from the CLI or the Workbench. As a default,
  128. the main window will open. (See "ToolTypes" for how to disable this.)
  129.   I hope that everything is quite straight-forward, so here is only a short
  130. description of the gadgets: (The underlined character is the keyboard
  131. shortcut.)
  132.  
  133. Label        What is it good for?
  134. ---------------------------------------------------------------------------
  135. Window's    Closes the window, but doesn't quit the program.
  136. close-gadget
  137.  
  138. Events        Contains all the events that Noisome currently supports.
  139.     ¯        Click on the one you want to edit.
  140.  
  141. Sound        The name of the current sample. Note that it doesn't have
  142.         to be the same as the filename.
  143.  
  144. Play        Plays the sample. Actually, two samples can be played if
  145. ¯        you also have a sampled connected to the left mousebutton.
  146.  
  147. File        Here you enter the filename of the sample to be associated
  148. ¯         with the selected event. Entering an empty string removes
  149.          the loaded sample from memory.
  150.          If the file isn't an 8SVX-type IFF, it will be treated
  151.          as raw data.
  152.  
  153. Browse        Brings up a filerequester.
  154. ¯
  155. Volume        Well... Sets the volume of the current sample, I guess...
  156. ¯
  157. Enabled        If this gadget is NOT checked, then the sample will remain
  158.  ¯        loaded, but it won't be played.
  159.  
  160. Flash screen    This only applies to the DisplayBeep-event. If you can't
  161.       ¯        live without a flashing screen, this is the gadget for you!
  162.         In WB2.1, it also means that the sound you selected in
  163.         Sound-prefs will be played.
  164.  
  165. (The following gadgets affect all samples)
  166. Filter        With this gadget you can enable and disable the hardware
  167.  ¯        low-pass filter that make samples sound very muffled.
  168.  
  169. Channels    Lets you choose how the channels will be allocated.
  170. ¯        Note that the channels stay allocated for as long as
  171.         Noisome runs! However, you can change the priority, so
  172.         that other - more important -  sound-producing programs
  173.         won't fail to run. The different options are:
  174.  
  175.          1 mono      - One sound will be played in one channel.
  176.          2 mono      - Two sounds can be played at the same time, but
  177.                  they will stay in one speaker.
  178.          2 stereo  - One sound will be played in both speakers.
  179.          4 stereo  - Two sounds in both speakers.
  180.  
  181. Audio         This is the priority with which the channels are
  182. ¯priority     allocated. The value must be between -128 and 127.
  183.         Choose this value carefully! A high value (e.g 126 or
  184.         more) will effectively prevent your favourite music
  185.         program from starting. On the other hand, if you enter
  186.         a low priority, you will still hear the ugly warning
  187.         beeps that some programs produce instead of a lovely
  188.         sample of yours. I suggest that you experiment with
  189.         different combinations of channels/priorities.
  190.  
  191. Task priority    This is the priority of the task that sits and listens
  192.    ¯        for the events and play the samples. A low value won't give
  193.         any overhead at all, but a sample isn't always played
  194.         when an event occurs. Experiment with different values!
  195.  
  196. Enable        Noisome will listen for events and play the appropriate
  197. ¯        samples.
  198.  
  199. Disable        No samples will be played and the channels are deallocated.
  200. ¯        You can't bring up the window by pressing the hot-key
  201.         combination.
  202.  
  203. Hide        Closes the window, but doesn't quit the program.
  204. ¯
  205. Quit        Quits Noisome. You should never have to do this.
  206. ¯
  207. These are the menus and their shortcuts, if any:
  208.  
  209. Noisome
  210.  About      ?    Shows the current version of the program.
  211.  
  212.  Enable        Noisome will listen for events and play the appropriate
  213.         samples.
  214.  
  215.  Disable    No samples will be played and the channels are deallocated.
  216.  
  217.  Hide        Closes the window, but doesn't quit the program.
  218.  
  219.  Quit       Q    Quits Noisome. You should never ever have to do this.:)
  220.  
  221. Preferences
  222.  Open...    O    Loads new preferences. All samples currently loaded will
  223.          be deallocated.
  224.  
  225.  Save       S    Saves all the settings to a file. The filename will be
  226.          the one of the last loaded preference file.
  227.  
  228.  Save as... A    Saves all the settings to a file of your choice.
  229.  
  230. 5. ToolTypes
  231. ============
  232. Noisome recognises the following ToolTypes: (They can also be type in
  233. as parameters from the CLI)
  234.  
  235. PREFSFILE=<filename>    The path of the preferences file that Noisome
  236.             will look for when the program is started.
  237.             The default is 'Noisome.prefs'.
  238.  
  239. CX_POPKEY=<expression>    The key-combination that will bring up the main
  240.             window when it is closed. See your Workbench-
  241.             documentation for details. Default is 'ctrl lalt n',
  242.             which means the Control key together with the left
  243.             Alt-key and 'n'.
  244.  
  245. CX_PRIORITY=<priority>    The priority of Noisome in the Commodities
  246.             handler chain. The default is 0.
  247.  
  248. CX_POPUP=[YES|NO]    Whether the main window should be opened or
  249.             not at startup. Default is YES.
  250.  
  251. DONOTWAIT        This is useful if you put Noisome in your
  252.             WbStartup-drawer. See your Workbench-documentation
  253.             for details.
  254.  
  255. 6. Known problems
  256. =================
  257. Well, er... There seems to be a problem when you have allocated several
  258. channels at a low priority. When you run a program that quickly allocates
  259. and deallocates one or two channels, Noisome sometimes seems to hang...
  260.   But have no fear! Noisome will revive if you start another program that
  261. allocates ALL channels and then releases them.
  262.   To avoid this problem, only allocate one or two channels or to set a
  263. higher audio priority, like 100 or so.
  264.  
  265. 7. Problems never heard of
  266. ==========================
  267. If your Amiga suddenly vaporizes or gets localized in Hebrew, you've
  268. just experienced what I usually refer to as an undocumented sideeffect,
  269. and I would like to hear from you.
  270.   Please, carefully write down the steps that produced the mishap, so
  271. that I won't do the same mistake on my own machine.;)
  272.  
  273.  
  274. THANKS to Anders Hammarqvist and Martin Kullgren, for testing and
  275. giving suggestions!!
  276.  
  277.  
  278.  
  279.         /¯\ David Larsson /¯\  Engineering Physics                /¯\_/¯¯¯¯
  280.        /   \_/¯\   /¯¯¯\_/   \ Chalmers University of Technology / Sweden
  281.       /         \_/           \      /¯\   /¯\     /¯\_/¯\      /
  282. ¯\   /                         \    /   \_/   \   /       \    /
  283.   \_/  f92dala@fy.chalmers.se   \__/           \_/         \__/
  284.